Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RNMobile] Audio & Video block - Autoplay BottomSheet Cell help support #30885

Merged
merged 17 commits into from
May 18, 2021

Conversation

jd-alexander
Copy link
Contributor

@jd-alexander jd-alexander commented Apr 16, 2021

Gutenberg Mobile PR wordpress-mobile/gutenberg-mobile#3380

Description

This PR introduces help behavior that exists on the web, to native BottomSheet Cell components. This change arose from the need to inform users of the usability implications that may be experienced by users if the autoplay attribute is enabled on the Audio and Video block.

How has this been tested?

Audio block

  1. Add an Audio block to the canvas.
  2. Add an audio file to the block.
  3. Open the Audio block settings.
  4. Notice that the Autoplay attribute has the help text below it.
Android - Light Mode Android - Dark Mode
iOS - Light Mode iOS - Dark Mode

Video block

  1. Add a Video block to the canvas.
  2. Add a video file to the block.
  3. Open the Video block settings.
  4. Notice that the Autoplay attribute has the help text below it.
Android - Light Mode Android - Dark Mode
iOS - Light Mode iOS - Dark Mode

Regression Testing - Web

  1. run npm run wp-env start
  2. Log into wpadmin.
  3. Add a Video block.
  4. Verify that the autoplay help text only gets shown when the autoplay attribute is checked.

Types of changes

From an implementation standpoint, the changes are as follows:

  1. The ToggleControl of the native Audio block now contains the help text of Note: Autoplaying audio may cause usability issues for some visitors.
  2. The Video Block already contained help text because the settings for native and web are shared. However, the behavior on the web only shows the autoplay help text when the autoplay attribute is checked, but on mobile, the text should always be visible so platform-specific logic was implemented to facilitate this differentiation.
  3. The BottomSheet Cell in native, was extended to support the help text, so that the toggle-control would behave as expected when the help prop is passed. A side effect of this change is that all components that inherit Cell such as cycle-select-control, range-control, select-control, text-control, textarea-control are able to utilize the behavior.
  4. For the Video block, I realized there's a shared settings file for both mobile and web. For the Audio block, we had duplicated the settings, so I am now wondering if this is an improvement that's needed. It's quite minor, nonetheless, I am sharing it here since I observed it.

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • I've tested my changes with keyboard and screen readers.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR (please manually search all *.native.js files for terms that need renaming or removal).

@jd-alexander jd-alexander added the Mobile App - i.e. Android or iOS Native mobile impl of the block editor. (Note: used in scripts, ping mobile folks to change) label Apr 16, 2021
@jd-alexander jd-alexander requested a review from ceyhun April 16, 2021 02:09
@jd-alexander jd-alexander requested a review from ajitbohra as a code owner April 16, 2021 02:09
@github-actions
Copy link

github-actions bot commented Apr 16, 2021

Size Change: +3 B (0%)

Total Size: 1.3 MB

Filename Size Change
build/block-library/index.js 146 kB +3 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.12 kB 0 B
build/annotations/index.js 2.93 kB 0 B
build/api-fetch/index.js 2.42 kB 0 B
build/autop/index.js 2.28 kB 0 B
build/blob/index.js 673 B 0 B
build/block-directory/index.js 6.61 kB 0 B
build/block-directory/style-rtl.css 993 B 0 B
build/block-directory/style.css 995 B 0 B
build/block-editor/index.js 118 kB 0 B
build/block-editor/style-rtl.css 13 kB 0 B
build/block-editor/style.css 13 kB 0 B
build/block-library/blocks/archives/editor-rtl.css 61 B 0 B
build/block-library/blocks/archives/editor.css 60 B 0 B
build/block-library/blocks/audio/editor-rtl.css 58 B 0 B
build/block-library/blocks/audio/editor.css 58 B 0 B
build/block-library/blocks/audio/style-rtl.css 112 B 0 B
build/block-library/blocks/audio/style.css 112 B 0 B
build/block-library/blocks/block/editor-rtl.css 161 B 0 B
build/block-library/blocks/block/editor.css 161 B 0 B
build/block-library/blocks/button/editor-rtl.css 475 B 0 B
build/block-library/blocks/button/editor.css 474 B 0 B
build/block-library/blocks/button/style-rtl.css 601 B 0 B
build/block-library/blocks/button/style.css 600 B 0 B
build/block-library/blocks/buttons/editor-rtl.css 315 B 0 B
build/block-library/blocks/buttons/editor.css 315 B 0 B
build/block-library/blocks/buttons/style-rtl.css 375 B 0 B
build/block-library/blocks/buttons/style.css 375 B 0 B
build/block-library/blocks/calendar/style-rtl.css 208 B 0 B
build/block-library/blocks/calendar/style.css 208 B 0 B
build/block-library/blocks/categories/editor-rtl.css 84 B 0 B
build/block-library/blocks/categories/editor.css 83 B 0 B
build/block-library/blocks/categories/style-rtl.css 79 B 0 B
build/block-library/blocks/categories/style.css 79 B 0 B
build/block-library/blocks/code/style-rtl.css 90 B 0 B
build/block-library/blocks/code/style.css 90 B 0 B
build/block-library/blocks/columns/editor-rtl.css 190 B 0 B
build/block-library/blocks/columns/editor.css 190 B 0 B
build/block-library/blocks/columns/style-rtl.css 422 B 0 B
build/block-library/blocks/columns/style.css 422 B 0 B
build/block-library/blocks/cover/editor-rtl.css 643 B 0 B
build/block-library/blocks/cover/editor.css 645 B 0 B
build/block-library/blocks/cover/style-rtl.css 1.22 kB 0 B
build/block-library/blocks/cover/style.css 1.22 kB 0 B
build/block-library/blocks/embed/editor-rtl.css 486 B 0 B
build/block-library/blocks/embed/editor.css 486 B 0 B
build/block-library/blocks/embed/style-rtl.css 401 B 0 B
build/block-library/blocks/embed/style.css 400 B 0 B
build/block-library/blocks/file/editor-rtl.css 301 B 0 B
build/block-library/blocks/file/editor.css 300 B 0 B
build/block-library/blocks/file/frontend.js 772 B 0 B
build/block-library/blocks/file/style-rtl.css 255 B 0 B
build/block-library/blocks/file/style.css 255 B 0 B
build/block-library/blocks/freeform/editor-rtl.css 2.45 kB 0 B
build/block-library/blocks/freeform/editor.css 2.45 kB 0 B
build/block-library/blocks/gallery/editor-rtl.css 704 B 0 B
build/block-library/blocks/gallery/editor.css 705 B 0 B
build/block-library/blocks/gallery/style-rtl.css 1.06 kB 0 B
build/block-library/blocks/gallery/style.css 1.05 kB 0 B
build/block-library/blocks/group/editor-rtl.css 160 B 0 B
build/block-library/blocks/group/editor.css 160 B 0 B
build/block-library/blocks/group/style-rtl.css 57 B 0 B
build/block-library/blocks/group/style.css 57 B 0 B
build/block-library/blocks/heading/editor-rtl.css 129 B 0 B
build/block-library/blocks/heading/editor.css 129 B 0 B
build/block-library/blocks/heading/style-rtl.css 76 B 0 B
build/block-library/blocks/heading/style.css 76 B 0 B
build/block-library/blocks/home-link/style-rtl.css 259 B 0 B
build/block-library/blocks/home-link/style.css 259 B 0 B
build/block-library/blocks/html/editor-rtl.css 281 B 0 B
build/block-library/blocks/html/editor.css 281 B 0 B
build/block-library/blocks/image/editor-rtl.css 717 B 0 B
build/block-library/blocks/image/editor.css 716 B 0 B
build/block-library/blocks/image/style-rtl.css 481 B 0 B
build/block-library/blocks/image/style.css 485 B 0 B
build/block-library/blocks/latest-comments/style-rtl.css 281 B 0 B
build/block-library/blocks/latest-comments/style.css 282 B 0 B
build/block-library/blocks/latest-posts/editor-rtl.css 137 B 0 B
build/block-library/blocks/latest-posts/editor.css 137 B 0 B
build/block-library/blocks/latest-posts/style-rtl.css 523 B 0 B
build/block-library/blocks/latest-posts/style.css 522 B 0 B
build/block-library/blocks/legacy-widget/editor-rtl.css 557 B 0 B
build/block-library/blocks/legacy-widget/editor.css 557 B 0 B
build/block-library/blocks/list/style-rtl.css 63 B 0 B
build/block-library/blocks/list/style.css 63 B 0 B
build/block-library/blocks/media-text/editor-rtl.css 176 B 0 B
build/block-library/blocks/media-text/editor.css 176 B 0 B
build/block-library/blocks/media-text/style-rtl.css 492 B 0 B
build/block-library/blocks/media-text/style.css 489 B 0 B
build/block-library/blocks/more/editor-rtl.css 434 B 0 B
build/block-library/blocks/more/editor.css 434 B 0 B
build/block-library/blocks/navigation-link/editor-rtl.css 617 B 0 B
build/block-library/blocks/navigation-link/editor.css 619 B 0 B
build/block-library/blocks/navigation-link/style-rtl.css 94 B 0 B
build/block-library/blocks/navigation-link/style.css 94 B 0 B
build/block-library/blocks/navigation/editor-rtl.css 1.54 kB 0 B
build/block-library/blocks/navigation/editor.css 1.54 kB 0 B
build/block-library/blocks/navigation/style-rtl.css 1.78 kB 0 B
build/block-library/blocks/navigation/style.css 1.78 kB 0 B
build/block-library/blocks/nextpage/editor-rtl.css 395 B 0 B
build/block-library/blocks/nextpage/editor.css 395 B 0 B
build/block-library/blocks/page-list/editor-rtl.css 310 B 0 B
build/block-library/blocks/page-list/editor.css 311 B 0 B
build/block-library/blocks/page-list/style-rtl.css 233 B 0 B
build/block-library/blocks/page-list/style.css 233 B 0 B
build/block-library/blocks/paragraph/editor-rtl.css 157 B 0 B
build/block-library/blocks/paragraph/editor.css 157 B 0 B
build/block-library/blocks/paragraph/style-rtl.css 247 B 0 B
build/block-library/blocks/paragraph/style.css 248 B 0 B
build/block-library/blocks/post-author/editor-rtl.css 209 B 0 B
build/block-library/blocks/post-author/editor.css 209 B 0 B
build/block-library/blocks/post-author/style-rtl.css 183 B 0 B
build/block-library/blocks/post-author/style.css 184 B 0 B
build/block-library/blocks/post-comments-form/style-rtl.css 140 B 0 B
build/block-library/blocks/post-comments-form/style.css 140 B 0 B
build/block-library/blocks/post-comments/style-rtl.css 360 B 0 B
build/block-library/blocks/post-comments/style.css 359 B 0 B
build/block-library/blocks/post-content/editor-rtl.css 139 B 0 B
build/block-library/blocks/post-content/editor.css 139 B 0 B
build/block-library/blocks/post-excerpt/editor-rtl.css 73 B 0 B
build/block-library/blocks/post-excerpt/editor.css 73 B 0 B
build/block-library/blocks/post-excerpt/style-rtl.css 69 B 0 B
build/block-library/blocks/post-excerpt/style.css 69 B 0 B
build/block-library/blocks/post-featured-image/editor-rtl.css 338 B 0 B
build/block-library/blocks/post-featured-image/editor.css 338 B 0 B
build/block-library/blocks/post-featured-image/style-rtl.css 119 B 0 B
build/block-library/blocks/post-featured-image/style.css 119 B 0 B
build/block-library/blocks/post-title/style-rtl.css 60 B 0 B
build/block-library/blocks/post-title/style.css 60 B 0 B
build/block-library/blocks/preformatted/style-rtl.css 103 B 0 B
build/block-library/blocks/preformatted/style.css 103 B 0 B
build/block-library/blocks/pullquote/editor-rtl.css 183 B 0 B
build/block-library/blocks/pullquote/editor.css 183 B 0 B
build/block-library/blocks/pullquote/style-rtl.css 318 B 0 B
build/block-library/blocks/pullquote/style.css 318 B 0 B
build/block-library/blocks/query-loop/editor-rtl.css 83 B 0 B
build/block-library/blocks/query-loop/editor.css 82 B 0 B
build/block-library/blocks/query-loop/style-rtl.css 315 B 0 B
build/block-library/blocks/query-loop/style.css 317 B 0 B
build/block-library/blocks/query-pagination-numbers/editor-rtl.css 122 B 0 B
build/block-library/blocks/query-pagination-numbers/editor.css 121 B 0 B
build/block-library/blocks/query-pagination/editor-rtl.css 270 B 0 B
build/block-library/blocks/query-pagination/editor.css 262 B 0 B
build/block-library/blocks/query-pagination/style-rtl.css 168 B 0 B
build/block-library/blocks/query-pagination/style.css 168 B 0 B
build/block-library/blocks/query-title/editor-rtl.css 86 B 0 B
build/block-library/blocks/query-title/editor.css 86 B 0 B
build/block-library/blocks/query/editor-rtl.css 131 B 0 B
build/block-library/blocks/query/editor.css 132 B 0 B
build/block-library/blocks/quote/style-rtl.css 169 B 0 B
build/block-library/blocks/quote/style.css 169 B 0 B
build/block-library/blocks/rss/editor-rtl.css 201 B 0 B
build/block-library/blocks/rss/editor.css 202 B 0 B
build/block-library/blocks/rss/style-rtl.css 290 B 0 B
build/block-library/blocks/rss/style.css 290 B 0 B
build/block-library/blocks/search/editor-rtl.css 189 B 0 B
build/block-library/blocks/search/editor.css 189 B 0 B
build/block-library/blocks/search/style-rtl.css 359 B 0 B
build/block-library/blocks/search/style.css 362 B 0 B
build/block-library/blocks/separator/editor-rtl.css 99 B 0 B
build/block-library/blocks/separator/editor.css 99 B 0 B
build/block-library/blocks/separator/style-rtl.css 251 B 0 B
build/block-library/blocks/separator/style.css 251 B 0 B
build/block-library/blocks/shortcode/editor-rtl.css 512 B 0 B
build/block-library/blocks/shortcode/editor.css 512 B 0 B
build/block-library/blocks/site-logo/editor-rtl.css 440 B 0 B
build/block-library/blocks/site-logo/editor.css 441 B 0 B
build/block-library/blocks/site-logo/style-rtl.css 154 B 0 B
build/block-library/blocks/site-logo/style.css 154 B 0 B
build/block-library/blocks/social-link/editor-rtl.css 164 B 0 B
build/block-library/blocks/social-link/editor.css 165 B 0 B
build/block-library/blocks/social-links/editor-rtl.css 796 B 0 B
build/block-library/blocks/social-links/editor.css 795 B 0 B
build/block-library/blocks/social-links/style-rtl.css 1.32 kB 0 B
build/block-library/blocks/social-links/style.css 1.33 kB 0 B
build/block-library/blocks/spacer/editor-rtl.css 308 B 0 B
build/block-library/blocks/spacer/editor.css 308 B 0 B
build/block-library/blocks/spacer/style-rtl.css 48 B 0 B
build/block-library/blocks/spacer/style.css 48 B 0 B
build/block-library/blocks/table/editor-rtl.css 478 B 0 B
build/block-library/blocks/table/editor.css 478 B 0 B
build/block-library/blocks/table/style-rtl.css 485 B 0 B
build/block-library/blocks/table/style.css 485 B 0 B
build/block-library/blocks/tag-cloud/editor-rtl.css 118 B 0 B
build/block-library/blocks/tag-cloud/editor.css 118 B 0 B
build/block-library/blocks/tag-cloud/style-rtl.css 94 B 0 B
build/block-library/blocks/tag-cloud/style.css 94 B 0 B
build/block-library/blocks/template-part/editor-rtl.css 551 B 0 B
build/block-library/blocks/template-part/editor.css 550 B 0 B
build/block-library/blocks/term-description/editor-rtl.css 90 B 0 B
build/block-library/blocks/term-description/editor.css 90 B 0 B
build/block-library/blocks/text-columns/editor-rtl.css 95 B 0 B
build/block-library/blocks/text-columns/editor.css 95 B 0 B
build/block-library/blocks/text-columns/style-rtl.css 166 B 0 B
build/block-library/blocks/text-columns/style.css 166 B 0 B
build/block-library/blocks/verse/style-rtl.css 87 B 0 B
build/block-library/blocks/verse/style.css 87 B 0 B
build/block-library/blocks/video/editor-rtl.css 569 B 0 B
build/block-library/blocks/video/editor.css 570 B 0 B
build/block-library/blocks/video/style-rtl.css 169 B 0 B
build/block-library/blocks/video/style.css 169 B 0 B
build/block-library/common-rtl.css 1.26 kB 0 B
build/block-library/common.css 1.26 kB 0 B
build/block-library/editor-rtl.css 9.9 kB 0 B
build/block-library/editor.css 9.89 kB 0 B
build/block-library/reset-rtl.css 506 B 0 B
build/block-library/reset.css 507 B 0 B
build/block-library/style-rtl.css 10.2 kB 0 B
build/block-library/style.css 10.3 kB 0 B
build/block-library/theme-rtl.css 692 B 0 B
build/block-library/theme.css 693 B 0 B
build/block-serialization-default-parser/index.js 1.3 kB 0 B
build/block-serialization-spec-parser/index.js 3.06 kB 0 B
build/blocks/index.js 47.1 kB 0 B
build/components/index.js 188 kB 0 B
build/components/style-rtl.css 16.4 kB 0 B
build/components/style.css 16.3 kB 0 B
build/compose/index.js 9.92 kB 0 B
build/core-data/index.js 12.1 kB 0 B
build/customize-widgets/index.js 5.99 kB 0 B
build/customize-widgets/style-rtl.css 698 B 0 B
build/customize-widgets/style.css 699 B 0 B
build/data-controls/index.js 828 B 0 B
build/data/index.js 7.23 kB 0 B
build/date/index.js 31.8 kB 0 B
build/deprecated/index.js 739 B 0 B
build/dom-ready/index.js 577 B 0 B
build/dom/index.js 4.62 kB 0 B
build/edit-navigation/index.js 13.6 kB 0 B
build/edit-navigation/style-rtl.css 2.83 kB 0 B
build/edit-navigation/style.css 2.83 kB 0 B
build/edit-post/classic-rtl.css 454 B 0 B
build/edit-post/classic.css 454 B 0 B
build/edit-post/index.js 334 kB 0 B
build/edit-post/style-rtl.css 6.84 kB 0 B
build/edit-post/style.css 6.83 kB 0 B
build/edit-site/index.js 26 kB 0 B
build/edit-site/style-rtl.css 4.79 kB 0 B
build/edit-site/style.css 4.78 kB 0 B
build/edit-widgets/index.js 12.5 kB 0 B
build/edit-widgets/style-rtl.css 3.02 kB 0 B
build/edit-widgets/style.css 3.03 kB 0 B
build/editor/index.js 38.4 kB 0 B
build/editor/style-rtl.css 3.95 kB 0 B
build/editor/style.css 3.95 kB 0 B
build/element/index.js 3.44 kB 0 B
build/escape-html/index.js 739 B 0 B
build/format-library/index.js 5.67 kB 0 B
build/format-library/style-rtl.css 637 B 0 B
build/format-library/style.css 639 B 0 B
build/hooks/index.js 1.76 kB 0 B
build/html-entities/index.js 628 B 0 B
build/i18n/index.js 3.73 kB 0 B
build/is-shallow-equal/index.js 710 B 0 B
build/keyboard-shortcuts/index.js 1.65 kB 0 B
build/keycodes/index.js 1.43 kB 0 B
build/list-reusable-blocks/index.js 2.06 kB 0 B
build/list-reusable-blocks/style-rtl.css 629 B 0 B
build/list-reusable-blocks/style.css 628 B 0 B
build/media-utils/index.js 3.08 kB 0 B
build/navigation/index.js 2.85 kB 0 B
build/notices/index.js 1.07 kB 0 B
build/nux/index.js 2.31 kB 0 B
build/nux/style-rtl.css 718 B 0 B
build/nux/style.css 716 B 0 B
build/plugins/index.js 1.99 kB 0 B
build/primitives/index.js 1.03 kB 0 B
build/priority-queue/index.js 791 B 0 B
build/react-i18n/index.js 923 B 0 B
build/redux-routine/index.js 2.82 kB 0 B
build/reusable-blocks/index.js 2.54 kB 0 B
build/reusable-blocks/style-rtl.css 225 B 0 B
build/reusable-blocks/style.css 225 B 0 B
build/rich-text/index.js 10.7 kB 0 B
build/server-side-render/index.js 1.64 kB 0 B
build/shortcode/index.js 1.68 kB 0 B
build/token-list/index.js 847 B 0 B
build/url/index.js 1.95 kB 0 B
build/viewport/index.js 1.28 kB 0 B
build/warning/index.js 1.13 kB 0 B
build/widgets/index.js 1.66 kB 0 B
build/wordcount/index.js 1.24 kB 0 B

compressed-size-action

@jd-alexander
Copy link
Contributor Author

Hi @iamthomasbishop I need some design feedback based on the proposal you had shared with me here.

  1. Currently in the screenshots above, I did not move the Autoplay component to the bottom of the bottom sheet. Is this something you are still interested in seeing? My rationale for not moving it was, the Settings component for the Video block is shared between both mobile and web so if I moved it, it would also move the location of the component on the web as well and I am not sure if that's a change you would want us to make.
  2. In the design spec, you removed the word Note from the help text. eg. Note: Autoplaying audio may cause usability issues for some visitors. became Autoplaying audio may cause usability issues for some visitors. Again, I am utilizing shared logic within the Video block for mobile and web, so if I make this change it would cause a change for both platforms.

@iamthomasbishop
Copy link

@jd-alexander Looking good, thanks for the ping!

did not move the Autoplay component to the bottom of the bottom sheet. Is this something you are still interested in seeing?

I mean "ideally" I'd prefer to see this cell at the bottom because it's the only row with a note attached, but I understand what you're saying and agree it's not worth diverging in this case. So if we're unable to move the cell, I'm fine with shipping this as-is.

Moving forward, it might be worth proposing a more condensed version of the label for all platforms to use, which if accepted, we would simply inherit without additional work. I'm open to any ideas, but here are a few suggestions for a more concise note (which could be used on a variety of blocks that contain autoplay functionality):

  • Autoplaying media may cause usability issues
  • Autoplay may cause usability issues (also, if we went this route we could afford to keep the Note: part)
  • Autoplay may cause usability issues for some users

Let me know if you have any thoughts, but feel free to 🚢 this one and we can proceed if need be with the label changes separately. 👏

Copy link
Contributor

@AmandaRiu AmandaRiu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jd-alexander Looked over the code and tested on Android and iOS and all runs smoothly. I left one code comment for your review -- more of a question for me. I also noticed that the bottom margin below the help text do not match the bottom margins for settings options that do not have help text. I'm wondering if it needs to be slightly increased to give a more uniform looks to settings?

Screen Shot 2021-04-19 at 4 52 44 PM

@AmandaRiu
Copy link
Contributor

I also verified the web version as well for Audio and Video blocks. Neither shows the help text unless the autoplay option is toggled.

@AmandaRiu
Copy link
Contributor

@jd-alexander one final comment. I tested on Android with Talkback and the help message never gets read by the screenreader. Maybe the message could be read as part of the accessibilityHint? Just an idea.

screencapture-1618867210853.mp4

@jd-alexander
Copy link
Contributor Author

I mean "ideally" I'd prefer to see this cell at the bottom because it's the only row with a note attached, but I understand what you're saying and agree it's not worth diverging in this case. So if we're unable to move the cell, I'm fine with shipping this as-is.

No prob @iamthomasbishop I will keep it as is 👍🏾

Moving forward, it might be worth proposing a more condensed version of the label for all platforms to use, which if accepted, we would simply inherit without additional work. I'm open to any ideas, but here are a few suggestions for a more concise note (which could be used on a variety of blocks that contain autoplay functionality):

Autoplay may cause usability issues for some users

I think this is one is a good approach! I will make the necessary updates.

Let me know if you have any thoughts, but feel free to 🚢 this one and we can proceed if need be with the label changes separately. 👏

Will do 🙇🏾

@jd-alexander
Copy link
Contributor Author

@jd-alexander Looked over the code and tested on Android and iOS and all runs smoothly. I left one code comment for your review -- more of a question for me. I also noticed that the bottom margin below the help text do not match the bottom margins for settings options that do not have help text. I'm wondering if it needs to be slightly increased to give a more uniform looks to settings?

Thanks for spotting this @AmandaRiu working on the changes to make the margins unified.

@jd-alexander one final comment. I tested on Android with Talkback and the help message never gets read by the screenreader. Maybe the message could be read as part of the accessibilityHint? Just an idea.

Good idea! I am working on changing how the accessibility labels are generated. Currently, logic for this lives with the cell and the switch-cell component as well, so I am seeing how I can extend both to support the hint.

@jd-alexander
Copy link
Contributor Author

  1. Hi @AmandaRiu for the margin changes, I realized that Android's cell container has more margin than iOS, so when adjusting the margins I utilized platform-specific styles so the margin is appropriately spaced in relation to the settings option. Grid comparing both platforms below. 330f509

grids

  1. For the accessibility changes, I am working on the optimal approach to modifying these two parts of the codebase:

What I am working on accomplishing, is logic that allows the appropriate labels to generate when the help text is available or not without too many duplications of the sprintf templates/logic.

@jd-alexander
Copy link
Contributor Author

@iamthomasbishop web and mobile now has one string for all platforms 29b4393

Web

Audio Settings Video Settings
Screenshot 2021-04-20 at 1 04 42 AM Screenshot 2021-04-20 at 1 06 21 AM

Mobile

Audio Settings Video

Copy link
Member

@ceyhun ceyhun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@jd-alexander
Copy link
Contributor Author

Thanks @ceyhun I am going to be updating the PR with accessibility improvements for @AmandaRiu to review. Thanks for the review 🙇🏾

@jd-alexander
Copy link
Contributor Author

jd-alexander commented May 12, 2021

Hi @AmandaRiu I implemented the accessibility improvements that were requested. Let me know what you think.

Testing

Switch cell

Note

The switch cell implements a different mechanism for generating its accessibility label that includes the toggled state in the label.

Steps

  1. Launch the Gutenberg demo app.
  2. Enable either Talkback or VoiceOver.
  3. Open the Video settings.
  4. Notice the Autoplay option reads the help text.
  5. Toggle the control and notice that the ON/OFF values changes.
Android iOS

Cell

Prerequisite

you can add help={ getAutoplayHelp } to SelectControl of the Video Settings. as it utilizes the bottom sheet cell accessibility behavior. All other controls that inherit from cell automatically benefits from this change.

Steps

  1. Launch the Gutenberg demo app.
  2. Enable either Talkback or VoiceOver.
  3. Open the Video settings.
  4. Notice the Preload option reads the help text.
Android iOS

Concerns

The main thing I noticed was that the generated label read by VoiceOver/TalkBack contains an extra full stop at the end because the text has its own full stop and we also include it in the string template being utilized. It seems fine because it doesn't impact the announcement but I am just bringing it up nonetheless.

@jd-alexander jd-alexander requested a review from AmandaRiu May 13, 2021 13:05
@AmandaRiu AmandaRiu self-assigned this May 13, 2021
Copy link
Contributor

@AmandaRiu AmandaRiu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jd-alexander LGTM! Nice work! :shipit:

@jd-alexander
Copy link
Contributor Author

@jd-alexander LGTM! Nice work! :shipit:

Thanks for the review @AmandaRiu 😄

@jd-alexander
Copy link
Contributor Author

jd-alexander commented May 18, 2021

@hypest I haven't been able to get this PR merged because I think the current Unit Tests/ PHP are flaky. I have done several re-runs today. The changes here did not touch anything PHP or theme-related so I am thinking that the failure has nothing to do with my changes.

@hypest
Copy link
Contributor

hypest commented May 18, 2021

Thanks for the ping Joel! I verified that the failed "Unit tests /PHP (pull_request)" is failing with the same failures on current trunk (commit 29078b0) so, I will go ahead and admin-merge this PR 👍

@hypest hypest merged commit c290539 into trunk May 18, 2021
@hypest hypest deleted the rnmobile/bottomsheet-cell-help branch May 18, 2021 07:47
@github-actions github-actions bot added this to the Gutenberg 10.7 milestone May 18, 2021
@ellatrix
Copy link
Member

Why was this merged with failing tests? It's not because it's trunk is failing that that's ok?

@hypest
Copy link
Contributor

hypest commented May 19, 2021

Why was this merged with failing tests? It's not because it's trunk is failing that that's ok?

👋 @ellatrix ! No other reason than that actually. It was clear that this PR wasn't introducing the failures and there were no other failures besides those already in trunk. Went ahead with merging to move the native mobile side forward since the particular PHP failures do not block native mobile.

Happy to revise the practice though (merging if PR is dimmed irrelevant to the CI failures) if it's understood that all PRs should block if CI is red.

Also, in this particular case, not sure, has this PR caused some regression perhaps? More than happy to dive in or revert if is has introduced regressions 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Mobile App - i.e. Android or iOS Native mobile impl of the block editor. (Note: used in scripts, ping mobile folks to change)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants